-
Notifications
You must be signed in to change notification settings - Fork 109
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
DOC: Changelog and Readme for github. Closes #22 #23
base: master
Are you sure you want to change the base?
Conversation
Thanks @OceanWolf |
A pleasure, tomorrow, I will have a go at installing scribus from here and seeing what I get. I guess just have to install and run Also I will squash the commits before you merge into master. With the svn, does an equivilant to .gitignore exist? |
@luzpaz i made a try yesterday evening with a README_github.md and chitz was not happy with it and we (he; thanks!) reverted the commit. |
---------------------- | ||
- GitHub has become a way to quickly and ingeniously collaborate. | ||
- Git has also seemed to surpass Subversion. | ||
- GitHub has an enormous developer pool. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
i don't think that we need the section above: everybody who is using github knows why scribus should be on github...
Sure I can address those comments, but what/who does |
chitz is the contributor who has created the script for keeping the github repository in sync with the svn one. life is complicated :-) |
Darn, any chance of copying the reasoning over to here? At least for reference purposes... also I feel curious with what you mean by "for now"... |
in short:
|
Ahh, okay, what do you think about rewriting the readme so that it can apply to both svn and git? Something along the lines of "people wanting to help develop Scribus should do so through the github repository at https://github.com/scribusproject/ for more information see http://scribus.io/", or does the Scribus Team not want to give us such a blessing just yet ;). Not really important, just if an easy option like that exists, then we might as well take it. |
@aoloe opinion ? |
DW, I will scrap this and rewrite the readme, first I want to get the documentation sorted in #25 |
right now, at least part of the team seems to be rather allergic to github... personally, i don't like the current README. the question is: for whom should a README be written? who reads a README file? my answer (ok, it's probably also my point of view): people who have downloaded (or are ready for downloading) the source code. a big part of them are potential developers. the other big part are testers. we should write a much shorter text that appeals to them and move the what's new file to a CHANGELOG file (that gets updated when important features are implemented). right now, the main message i get from the README is: "hey, look at us and see how we are cool"... it's an sane approach, but it does not fit "my way" and i'm not sure that it's the most useful message in that file. proposing a new good README could be an approach for improving the current state. |
👍 My sentiments exactly, as you see I did exactly that here, well, I only copied the I regularly now come onto the IRC channel, so I could announce it there once I have a first draft of this one readme to rule them all, and at the same time ask for feedback (and help/encourage people to use the github feedback mechanism, i.e. PR Comments (like this one) and Line Comments). |
Items still left to include:
Anything else...?
Eventually we should write some tests, perhaps we can do that using python scripts...